Skip to main content

Update existing business account

PUT /api/v1/Businesses/update

Description

This endpoint allows you to update an existing business account.

Request

  • Path: /api/v{version}/Businesses/update

  • Headers:

    • Accept-Language: Change default response message language from English(en). Available languages fr,en
  • Request Body: UpdateBusinessRequest

  • Response: CreateBusinessResponse

Response Examples:

  1. Success:
{
"id": "123",
"name": "Updated Business Name",
"email": "business@example.com",
"phone": "123456789",
"address": "123 Updated Example St., Updatedville, EX, 12345"
}

/api/v1/Businesses/update

Headers

Content-TypeValue
Accept-Language

Headers

Content-TypeValue
Content-Typeapplication/json

Headers

Content-TypeValue
Accepttext/plain

Body (raw)

{
"id": `<uuid>`,
"name": `<string>`,
"incorporationDate": `<dateTime>`,
"industry": `<string>`,
"mobileNumber": `<string>`,
"countryOfIncorporation": `<string>`,
"incorporationType": `<string>`,
"incorporationNumber": `<string>`,
"websiteUrl": `<string>`,
"address": {
"addressLine1": `<string>`,
"addressLine2": `<string>`,
"state": `<string>`,
"city": `<string>`,
"zipCode": `<string>`
}
}

Response: 200

{
"succeeded": `<boolean>`,
"message": `<string>`,
"errors": [
`<string>`,
`<string>`
],
"data": {
"address": {
"addressLine1": `<string>`,
"addressLine2": `<string>`,
"state": `<string>`,
"city": `<string>`,
"zipCode": `<string>`
},
"id": `<uuid>`,
"userId": `<uuid>`,
"tenantId": `<uuid>`,
"name": `<string>`,
"incorporationDate": `<dateTime>`,
"industry": `<string>`,
"mobileNumber": `<string>`,
"countryOfIncorporation": `<string>`,
"incorporationType": `<string>`,
"incorporationNumber": `<string>`,
"websiteUrl": `<string>`,
"termsAndConditionsSignedAt": `<dateTime>`,
"clientId": `<integer>`
}
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PUT \ 
--url /api/v1/Businesses/update \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!